home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIAccessibleSelectable.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  111 lines
  1. /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 2003
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Marc Mulcahy (marc.mulcahy@sun.com)
  24.  *   Paul Sandoz (paul.sandoz@sun.com)
  25.  *   Bill Haneman (bill.haneman@sun.com)
  26.  *   Kyle Yuan (kyle.yuan@sun.com)
  27.  *   Aaron Leventhal (aaronl@netscape.com)
  28.  *
  29.  * Alternatively, the contents of this file may be used under the terms of
  30.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  31.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32.  * in which case the provisions of the GPL or the LGPL are applicable instead
  33.  * of those above. If you wish to allow use of your version of this file only
  34.  * under the terms of either the GPL or the LGPL, and not to allow others to
  35.  * use your version of this file under the terms of the MPL, indicate your
  36.  * decision by deleting the provisions above and replace them with the notice
  37.  * and other provisions required by the GPL or the LGPL. If you do not delete
  38.  * the provisions above, a recipient may use your version of this file under
  39.  * the terms of any one of the MPL, the GPL or the LGPL.
  40.  *
  41.  * ***** END LICENSE BLOCK ***** */
  42. #include "nsISupports.idl"
  43. #include "nsIAccessible.idl"
  44. #include "nsIArray.idl"
  45.  
  46. /**
  47.  * An interface for the accessibility module and in-process accessibility clients
  48.  * for dealing with getting and changing the selection of accessible nodes.
  49.  *
  50.  * @status UNDER_REVIEW
  51.  */
  52. [scriptable, uuid(34d268d6-1dd2-11b2-9d63-83a5e0ada290)]
  53. interface nsIAccessibleSelectable : nsISupports
  54. {
  55. %{C++
  56.     enum { eSelection_Add = 0U, eSelection_Remove = 1U, eSelection_GetState = 2U };
  57. %}
  58.     /**
  59.      * Return an nsIArray of selected nsIAccessible children 
  60.      */
  61.     nsIArray GetSelectedChildren();
  62.     
  63.     /**
  64.      * Returns the number of accessible children currently selected.
  65.      */
  66.     readonly attribute long selectionCount;
  67.  
  68.     /**
  69.      * Adds the specified accessible child of the object to the
  70.      * object's selection.
  71.      * If the specified object is already selected, then it does nothing.
  72.      * @throws NS_ERROR_FAILURE if the specified object is not selectable.
  73.      */
  74.     void addChildToSelection(in long index);
  75.  
  76.     /**
  77.      * Removes the specified child of the object from the object's selection.
  78.      * If the specified object was not selected, then it does nothing.
  79.      * @throws NS_ERROR_FAILURE if the specified object is not selectable.
  80.      */
  81.     void removeChildFromSelection(in long index);
  82.  
  83.     /**
  84.      * Clears the selection in the object so that no children in the object
  85.      * are selected.
  86.      */
  87.     void clearSelection();
  88.  
  89.     /**
  90.      * Returns a reference to the accessible object representing the specified
  91.      * selected child of the object.
  92.      * @param index Zero-based selected accessible child index 
  93.      * @return The nth selected accessible child
  94.      */
  95.     nsIAccessible refSelection(in long index);
  96.  
  97.     /**
  98.       * Determines if the current child of this object is selected
  99.       * @param The zero-based accessible child index
  100.       * @return Returns true if the child is selected, false if not.
  101.       */
  102.     boolean isChildSelected(in long index);
  103.  
  104.     /**
  105.      * Select all children
  106.      * @return If the object does not accept multiple selection, return false.
  107.      *         Otherwise, returns true.
  108.      */
  109.     boolean selectAllSelection();
  110. };
  111.